Skip to content

Fiie input recipe ref doc - #4869

Merged
blackgirlbytes merged 2 commits into
mainfrom
fiie-input-recipe-ref-doc
Sep 29, 2025
Merged

Fiie input recipe ref doc#4869
blackgirlbytes merged 2 commits into
mainfrom
fiie-input-recipe-ref-doc

Conversation

@blackgirlbytes

Copy link
Copy Markdown
Collaborator

This pull request updates the documentation for recipe parameter input types, clarifying the behavior of the file input type and providing a practical example. The changes make it easier for users to understand how to use file parameters in recipes and highlight important security considerations.

Documentation improvements for recipe parameters:

  • Clarified the input_type field in the parameters table to specify that it accepts "string" (default) or "file" (reads file contents).
  • Added a new "Input Types" section explaining the difference between string and file types, including a YAML example showing how to use a file parameter in a recipe.
  • Emphasized that file parameters cannot have default values to prevent accidental importing of sensitive files, and removed a redundant "File Parameter Type" subsection to streamline the documentation.

@blackgirlbytes
blackgirlbytes requested a review from a team as a code owner September 29, 2025 00:28
@github-actions

github-actions Bot commented Sep 29, 2025

Copy link
Copy Markdown
Contributor
PR Preview Action v1.6.0
Preview removed because the pull request was closed.
2025-09-29 03:47 UTC

@blackgirlbytes
blackgirlbytes merged commit cbefc3b into main Sep 29, 2025
12 checks passed
@blackgirlbytes
blackgirlbytes deleted the fiie-input-recipe-ref-doc branch September 29, 2025 03:47
michaelneale added a commit that referenced this pull request Sep 29, 2025
* main:
  fix: restoring test data and correcting name (#4875)
  Add .goosehints file to enforce lowercase branding in documentation (#4870)
  Fiie input recipe ref doc (#4869)
  doc: file parameter recipe update (#4594)
HikaruEgashira pushed a commit to HikaruEgashira/goose that referenced this pull request Oct 3, 2025
Signed-off-by: HikaruEgashira <hikaru-egashira@c-fo.com>
shafqatevo pushed a commit to shafqatevo/goose that referenced this pull request Aug 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants